home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / nt / gr564s.zip / SRC / README < prev    next >
Text File  |  1993-09-07  |  10KB  |  235 lines
  1. RCS configuration instructions
  2.  
  3.     $Id: README,v 1.9 1992/07/28 16:12:44 eggert Exp $
  4.  
  5.     Copyright 1991, 1992 by Paul Eggert
  6.     Distributed under license by the Free Software Foundation, Inc.
  7.  
  8.     This file is part of RCS.
  9.  
  10.     RCS is free software; you can redistribute it and/or modify it
  11.     under the terms of the GNU General Public License as published
  12.     by the Free Software Foundation; either version 2, or (at your
  13.     option) any later version.
  14.  
  15.     RCS is distributed in the hope that it will be useful, but
  16.     WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.     GNU General Public License for more details.
  19.  
  20.     You should have received a copy of the GNU General Public
  21.     License along with RCS; see the file COPYING.  If not, write to
  22.     the Free Software Foundation, 675 Mass Ave, Cambridge, MA
  23.     02139, USA.
  24.  
  25.     Report problems and direct all questions to:
  26.  
  27.         rcs-bugs@cs.purdue.edu
  28.  
  29.  
  30. For Posix and near-Posix hosts, configure by editing Makefile,
  31. commenting out wrong lines and uncommenting right ones.
  32. See ``Makefile notes'' below for advice.
  33.  
  34. After configuring, make conf.h; this may take a while,
  35. so you may want to do it in the background and run `tail -f a.h'
  36. or `tail -f conf.err' to check on progress.  If making conf.h fails,
  37. look in conf.err to see what went wrong in the conf.sh shell file.
  38. Check the resulting conf.h for plausibility; see ``conf.h notes'' below.
  39. If conf.h is wrong, and the mistake isn't listed in ``conf.h notes'',
  40. there is a bug in conf.sh; please report it.
  41. You can patch conf.h if you're in a hurry, but it's better to fix it;
  42. look at a.h and conf.err for ideas.
  43. If all else fails, copy conf.heg to conf.h and edit it by hand.
  44. After configuring, make `all'.
  45.  
  46. If all went well, make `install'.
  47. If installation succeeds, make `installtest';
  48. if this fails, make `installdebug' for detailed info.
  49.  
  50. If you want to test RCS before installing it,
  51. you must set RCSPREFIX to be empty, make RCS from scratch,
  52. prefix this directory to your PATH, and run `sh rcstest'.
  53. Be sure to restore RCSPREFIX and rebuild RCS before installing it.
  54.  
  55. If you want to maintain RCS with itself,
  56. preserve the original revision numbers, dates, etc.
  57. by checking the files in with the -k option.
  58.  
  59.  
  60. __________
  61.  
  62. Makefile notes
  63.  
  64. BINDIR is where the RCS commands will be installed.
  65.  
  66. CC is the name of your C compiler.
  67.  
  68. CC_D is a list of extra options for the C preprocessor.
  69. It should include any extra -D and -I options needed on your system.
  70.  
  71. CC_O is the C compiler options that affect just compilation and assembly;
  72. not preprocessing, linking or linting.
  73. If your compiler has the BSD -R option, -R can improve performance by
  74. making all initialized data read-only (not just string literals);
  75. this is not worth worrying about if your compiler also supports `const'.
  76.  
  77. CC_W is the list of C compiler options to enable
  78. warnings about questionable constructs in the RCS source code.
  79.  
  80. COMPAT2 is 1 if you still have version 2 RCS files around.
  81. (Version 2 became obsolete in 1982, so this isn't likely.)
  82. COMPAT2 assures that version 2 RCS files can still be read.
  83. When you have the new RCS installed, rename old version 2 RCS files as follows.
  84. Suppose the working file was `f.c';
  85. rename the RCS file `f.c.v' to `f.c,v', and the RCS file `f.v' to `f.c,v'.
  86. Thus suffixes are no longer dropped and RCS files end in `,v' rather than `.v'.
  87. After all version 2 RCS files have been updated with new versions of ci or rcs,
  88. you can remake RCS with COMPAT2 set to 0.
  89.  
  90. DESTBINDIR is the place where you want the RCS executables to be installed.
  91. This may be different from BINDIR due to installation staging.
  92.  
  93. DIFF is the name of your diff program.
  94. If you override DIFF, make sure you rebuild conf.h afterwards;
  95. otherwise you may introduce a security hole.
  96. On some versions of Unix, the standard diff does not support RCS
  97. and you must use something like /usr/lib/rdiff instead;
  98. perhaps you should try GNU diff instead.
  99.  
  100. DIFFPREFIX act likes RCSPREFIX, except it applies to subsidiary diffs,
  101. not to subsidiary RCS commands.  It must be nonempty if setuid is to be used.
  102.  
  103. DIFF_FLAGS are diff's options for RCS format output, probably -n.
  104. If available, also include the -a option for comparing arbitrary files.
  105.  
  106. DIFF_L is 1 if diff understands the -L option for labeling context diff output.
  107.  
  108. DIFF_SUCCESS, DIFF_FAILURE, DIFF_TROUBLE are integer constants
  109. representing diff's exit status when it finds
  110. no differences, some differences, or trouble respectively.
  111. The first two should be EXIT_SUCCESS and EXIT_FAILURE,
  112. but on some hosts they are broken.
  113.  
  114. DIFF3 is the name of the diff3 program.
  115. With GNU diff, this is simply its user-visible diff3 program.
  116. With traditional diff3, this is not the user-visible diff3 program;
  117. instead, it this is the name of the undocumented diff3 auxiliary program,
  118. whose name is /usr/lib/diff3 or /usr/5lib/rdiff3prog or something similar.
  119.  
  120. DIFF3_A is 1 if your diff3 has an -A option, 0 otherwise.
  121. This option is available in GNU diff 2.1 and later; it generates better
  122. quality diff3 output, but RCS is not yet ready for it.
  123.  
  124. DIFF3_BIN is 1 if DIFF3 is the user-visible GNU diff3 program (see DIFF3).
  125. Before setting this to 1, make sure your diff3 understands -a, -L, and and -m;
  126. e.g. the command `echo x | diff3 -m /dev/null /dev/null -' should output `x'.
  127.  
  128. ED is the name of the standard Unix line editor.
  129. It is needed only if DIFF3_BIN is 0.
  130.  
  131. EXECUTABLE_PERMISSIONS are the options given to INSTALL for executable files
  132. on BSD Unix sites.  Watch out for `-g staff' if you don't have a staff group,
  133. or if your installation program doesn't have a -g option.
  134.  
  135. INSTALL is the command that installs commands.
  136.  
  137. LDFLAGS are the loader flags you need, e.g. -i, -n, -s, -x.
  138.  
  139. LDLIBS are the loader libraries you need, e.g. -lbsd, -lBSD, -ljobs, -lPW, -lx.
  140.  
  141. LINK is the command used to link together an executable.
  142.  
  143. LINT is the name and usual arguments of your lint program.
  144.  
  145. OTHER_OBJECT are any other object files you need to link.
  146.  
  147. RCSCOMMANDS is the list of commands to be installed by default.
  148. It doesn't include rcsclean$x, which is still a little experimental.
  149.  
  150. RCSPREFIX is the prefix for subsidiary RCS commands like ci.
  151. If empty, RCS will search the PATH for these commands;
  152. this lets you move RCS commands after building them, and permits
  153. multiple instances of setuid RCS commands on the same host for different users.
  154. If nonempty, it should be a path followed by /;
  155. this makes RCS look in just one place, and makes execution faster.
  156.  
  157. REMOVE is how to remove a file.
  158.  
  159. SENDMAIL is a comma-separated list of strings that are a command to send mail.
  160. The name of the addressee will be appended as a separate argument,
  161. and the standard input will be the message
  162. (first line `Subject: xxxx', second line empty).
  163. If your host cannot send mail, leave SENDMAIL empty.
  164.  
  165. TESTPREFIX is the prefix for test commands.
  166.  
  167. o is the filename extension your host uses for object files.
  168. It includes the `.'.  It is typically `.o' on Unix hosts.
  169.  
  170. x is the filename extension your host uses for executables.
  171. It includes the `.'.  It is empty on Unix hosts,
  172. which traditionally lack extensions on executables.
  173.  
  174.  
  175. __________
  176.  
  177. conf.h notes
  178.  
  179. See conf.sh for details about the definitions in conf.h.
  180. Comments below cover unusual situations that can require hand patches to conf.h.
  181.  
  182. const - Some hosts support `const' but complain about it, perhaps because
  183. system headers are wrong.  `#define const /*empty*/' pacifies them.
  184.  
  185. has_NFS - Set this if the target host might use NFS.
  186. NFS's stateless server model has well-known problems with
  187. the non-idempotent operations link(), rename(), and unlink().
  188. For example, unlink() can run twice on the file server,
  189. causing the client to think that the unlink failed with errno==ENOENT.
  190. has_NFS enables code that works around these problems.
  191.  
  192. has_mmap - This should be 0 in HP-UX 8.07 unless you have patch PHKL_0942.
  193. Its NFS mmap() is broken, but if you run conf.sh in a non-NFS filesystem,
  194. conf.sh thinks mmap() works.
  195.  
  196. has_rename - This should be 0 in SCO Unix V.3.2.  Its NFS rename() is broken,
  197. but if you run conf.sh in a non-NFS filesystem, conf.sh thinks rename() works.
  198.  
  199. has_seteuid - This should be 1 only if your seteuid lets you switch back and
  200. forth between any pair of users as specified in Posix 1003.1a Draft 5.
  201. On some older systems (e.g. SunOS 4.0.3) seteuid doesn't allow this.
  202. One must be root to test this reliably, so conf.sh just guesses.
  203. If has_seteuid==0, the next best thing is saved setuid semantics
  204. (a Posix 1003.1-1990 option), because this fails only if you run as root.
  205. You may need to compile with `cc -systype sysv' (some Mips OS variants)
  206. or `cc -YPOSIX' (some Ultrix variants) for best results here.
  207.  
  208. large_memory - This should be 1 if main memory is large enough to hold entire
  209. copies of RCS files, perhaps because virtual memory is available.
  210.  
  211. NAME_MAX - this should be #undef'ed in AT&T SVR4.0 V2.0, which defines NAME_MAX
  212. to be 14 even though longer names are permitted on some filesystems.
  213. If you run conf.sh in a short-name filesystem, conf.sh won't detect this bug.
  214.  
  215. _POSIX_SOURCE must be #defined in a strict Standard C environment,
  216. because otherwise stdio.h cannot define useful names like fileno.
  217. Avoid defining _POSIX_SOURCE if possible,
  218. because it can disable useful non-Posix features in your host.
  219. Perhaps you can remove the need for _POSIX_SOURCE
  220. by supplying an option to your compiler to makes it less strict.
  221.  
  222. text_work_stdio - This option makes sense only on non-Posix hosts that
  223. distinguish between text and binary I/O, e.g. DOS.  Set this option if
  224. you want to use text I/O for working files, but binary I/O for RCS
  225. files.  If set, RCS does not support non-text working files, but RCS
  226. files are portable to other hosts across binary network file systems
  227. like NFS.  If not set, RCS supports non-text working files, but RCS
  228. files are not portable to Posix hosts.
  229.  
  230. TZ_must_be_set - set this to 1 on hosts where gmtime() yields bogus
  231. values unless the TZ environment variable is set.
  232.  
  233. volatile - See `const'.  E.g. `volatile sig_atomic_t' is conforming, but some
  234. buggy hosts complain.  Also, Ultrix 4.0 Mips CC 2.0 has buggy volatile support.
  235.